StreamPollDefs

Type: object

Schema to define stream (tcp/udp/ssh/serial/telnet) polls for a device

No Additional Properties

Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Duration

Type: object

Schema to define a finite duration

No Additional Properties

Type: integer

Type: enum (of string)

Must be one of:

  • "microsecond"
  • "microseconds"
  • "micro"
  • "micros"
  • "µs"
  • "millisecond"
  • "milliseconds"
  • "milli"
  • "millis"
  • "ms"
  • "second"
  • "seconds"
  • "s"
  • "minute"
  • "minutes"
  • "m"
  • "hour"
  • "hours"
  • "h"
  • "day"
  • "days"
  • "d"

Type: array

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

Type: object

Type: object
No Additional Properties

Type: string

Must be at least 1 characters long

Type: boolean

whether to run as admin

Type: boolean

If set to true then all commands with terminators must complete from terminators instead of from read timeouts

BinaryEncoding

Type: enum (of string)

Must be one of:

  • "base64"
  • "hex"
  • "utf8"
  • "utf16le"
  • "latin1"

Type: object

Parse data across packets. Useful for async data flows.

No Additional Properties

Type: string

Will use the configured output encoding of the poll.

Type: string

Will use the configured output encoding of the poll.

Type: boolean

Treat the search as a regex

RegexFlags

Type: array of enum (of string)

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp

All items must be unique

No Additional Items

Each item of this array must be:

Type: enum (of string)

Must be one of:

  • "g"
  • "i"
  • "m"
  • "s"
  • "u"
  • "y"
Type: object

Type: object

Requests are generally plain StringCommands, but constructing binary inputs is also supported. Output encoding defaults to UTF-8, but can be overridden for working with binary.

No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Type: object

Type: object

Type: object
No Additional Properties

Type: string

Optional, JSONPath to array if not operating on it directly


Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join

No Additional Properties
Type: object

Sum the numeric values in an array

No Additional Properties
Type: object

Flatten an array of arrays

No Additional Properties
Type: object

Combine an array of objects into one object

No Additional Properties

Type: boolean

Choose to overwrite values for duplicate keys or form a list of values


Filter an array


Type: object

Reduce an array. The transform will be run on each item in the array, with the input to the transform being an object with fields acc and current. The acc field will be populated with the xform init parameter for the first element. If the output of the transform is an object with an acc field, that will be used as the newly-accumulated value, otherwise the whole output will be in the acc field on the next item.

No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as preSendXform
Type: object

Convert an array of numbers to a string. Defaults to utf-8 encoding.

No Additional Properties

Type: object

Generates checksum from input string and returns isValid boolean or checksum-inserted string

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "validate"
  • "append"

Type: enum (of string)

Name of the algorithm (i.e. miteq, twoCharSum, mclCRC16)

Must be one of:

  • "miteq"
  • "twoCharSum"
  • "mclCRC16"

Type: string

Path to string property containing message to checksum

Type: object

Take an array of objects and a field to combine on, and output an array of objects with that field being unique among them, and other fields combined into arrays.

Type: object

Takes two arrays of objects and outputs one array with all the combinations of values of both. Transformation(s) can be provided to modify the output.

Type: object

Make a copy of a field with a new name or multiple new names

Type: object
No Additional Properties

Type: string

Copy a field from the root (ignoring operateOn) instead of using fieldName

Type: boolean

Remove the old field, if using fieldName mode

Type: object

Insert fields into an object, or values into an array

Type: object

Takes two arrays of objects, and outputs one array of combined objects, joined by a key field.

Type: object
No Additional Properties

Type: string

JSONPath to first array. The key field in this array should have unique values for each object.

Type: string

JSONPath to second array. The non-key fields of objects in this array will be collected into arrays on the matching record from the first array.

Type: boolean

Flag to keep the non key fields as objects. If not defined will turn non key fields into arrays. If using this flag and there are multiple values for a field based on the join, the last one will be chosen

Type: object

Type: object
No Additional Properties


Type: enum (of string)

Must be one of:

  • "ctof"
  • "ftoc"
  • "round"
  • "floor"
  • "ceil"
  • "sqrt"
  • "~"
  • "NOT"
Type: object

Move data

Type: object

Type: object
No Additional Properties


The current data (from operateOn) is replaced within an object

Type: array of string

'toSubField': ['a', 'b'] --> {'a': {'b': oldData}}

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

Type: object

Take a value and move it elsewhere. Tries to intelligently handle objects/arrays

No Additional Properties

Type: string

JSONPath to where value will be placed, or root if unspecified

Type: number

If target is array and this is unspecified, will append

Type: string

If target is an object and this is specified, add this field with the source value

Type: object

Takes the array of packets from a multiple-datasource field and transforms it into an object with the given field names and their payloads, optionally transformed

Type: object
No Additional Properties

Type: array of object
No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Type: string

Name in the final object which will contain the payload for this DS

Must be at least 1 characters long

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as preSendXform
Type: object

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "numberBitManipulation"


Type: object

Convert a signed integer to an unsigned integer or vice versa

No Additional Properties

Type: object

Convert a little endian integer to a bit endian integer or vice versa

No Additional Properties

Type: object

Type: object
No Additional Properties


Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toString

No Additional Properties

Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toFixed

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toExponential

No Additional Properties

Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/toPrecision

No Additional Properties

Type: object

Type: object
No Additional Properties


Type: object

Lookup table, incoming values will be replaced with their matching entry. If regex flag is true, keys should be valid regex patterns

Type: string

JSONPath expression that resolves to an object to which the same rules apply. This expression is applied to the original value (before operateOn is taken into account).

Type: boolean

If true, replacement keys must be valid regexes, and replacement values can be strings with $1 - $99 placeholders for match groups

RegexFlags

Type: array of enum (of string)

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp

Same definition as regexFlags
Type: object

Runs a rule with json-rules-engine and outputs based on whether the rule evaluates to true or false

Type: object
No Additional Properties

RuleXformRule

Type: object

A subset of json-rules-engine rules to be used in xforms

Type: object
No Additional Properties

Type: object

Type: object

Type: object

Type: object

Must provide one of value or valuePath

No Additional Properties

NormalRuleOperator

Type: enum (of string)

Must be one of:

  • "equal"
  • "notEqual"
  • "lessThan"
  • "lessThanInclusive"
  • "greaterThan"
  • "greaterThanInclusive"
  • "in"
  • "notIn"
  • "contains"
  • "doesNotContain"
  • "countEqual"
  • "countGreaterThan"
  • "countLessThan"
Type: object

Type: object

Treat two arrays as sets and perform set operations on them.

Type: object
No Additional Properties

Type: enum (of string)

Must be one of:

  • "union"
  • "intersection"
  • "difference"

Type: string

JSONPath to first array. First/second only makes a difference for difference op.

Type: string

JSONPath to second array. First/second only makes a difference for difference op.

Type: object

Type: object
No Additional Properties

Type: string

Name of the shared xforms file containing the transform

Type: object

A shared xform may define variables it can take in, if it does then values need to be provided to replace them with

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .+
Type: string
Type: object

Type: object

Apply transform(s) to an snmpGet payload, looked up by OID

No Additional Properties

Type: object

OID keys

No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(\d+[.])*\d+$
Type: object
No Additional Properties

Type: string

key in the resulting object for this transformed value

Type: object

Type: object

Apply transform(s) to columns in each row of an snmpGetTable payload

No Additional Properties

Type: enum (of string)

Must be one of:

  • "snmpGetTable"

Type: object
No Additional Properties

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: ^(\d+[.])*\d+$
Type: object
No Additional Properties

Type: boolean

Set to true to output an array of objects keyed by index

Type: object

Type: object
No Additional Properties


Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substring

No Additional Properties

Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/slice

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/substr

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/Trim

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimEnd

No Additional Properties
Type: object

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/trimStart

No Additional Properties

Type: object

Convert string to array of code points

No Additional Properties

Type: object

Join different strings together

No Additional Properties
Type: object

Create an object based on regex searches through text

Type: object
No Additional Properties

Type: object

Keys are regexes to search for

All properties whose name matches the following regular expression must respect the following conditions

Property name regular expression: .*
Type: object
No Additional Properties

DataTransformation

Type: object

Configurations for transforming data coming from devices

Same definition as preSendXform
Type: object

Type: object

Transform with a JS Script

No Additional Properties

Type: string

Runs a basic JS Script and outputs the returned result. A const input holds the result of the previous transforms.

Must match regular expression: ^((?!(\b(eval|Function|import|export|function|fs|file|File|os|close|open|addEventListener|removeEventListener|console|location|write|body|localStorage|sessionStorage|document|window|alert))[; .({]).)*$
Type: object

Requests are generally plain StringCommands, but constructing binary inputs is also supported. Output encoding defaults to UTF-8, but can be overridden for working with binary.

No Additional Properties

Type: object

StringCommand

Type: object

Defines 'commands' to be used in various places (sent during polls or commands on SSH, TCP, Serial, UDP). Plain strings can be commands, and they'll automatically get a newline appended. Alternatively, it can be an object with a custom or empty line ending.

Duration

Type: object

Schema to define a finite duration

Same definition as pollRate

Type: object

Search for a terminator. Can set a high read timeout if this is set, because presumably the poll will terminate by finding output instead of the connection going idle. Be aware if more output comes after the terminator, that output will most likely end up in later communications.

No Additional Properties

Type: boolean

Treat the search as a regex

RegexFlags

Type: array of enum (of string)

https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/RegExp

Same definition as regexFlags

Type: boolean

If set to false, the output of this command won't be in the final result

Type: boolean

If set to false, when the noDataTimeout is reached, no error will be generated. Note: currently doesn't apply to TCP

Type: array of object

Send data after connecting and drain responses

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Duration

Type: object

Schema to define a finite duration

Same definition as pollRate

Type: array of object

Send data after connecting and drain responses

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object
No Additional Properties

Duration

Type: object

Schema to define a finite duration

Same definition as pollRate

Type: string

Regex to remove a prompt from received data, for instance '

\s*$'

Must be at least 1 characters long